PBDTFlushSync

PBDTFlushSync
Header:	Files.h		Carbon status:	Supported

Saves your changes to the desktop database. This function runs synchronously.

OSErr PBDTFlushSync (
    DTPBPtr paramBlock
);

paramBlock: A pointer to a desktop parameter block.

function result: A result code.

DISCUSSION

Clear all fields (other than input fields) in the parameter block that you pass to Desktop Manager functions. The relevant fields of the parameter block for this function are:

ioCompletionOn input, a universal procedure pointer to a completion function. A value type of IOCompletionUPP.
ioResultOn return, the result code of the function. A value of type OSErr.
ioDTRefNumOn input, the desktop database reference number. A value of type SInt16.

If your application adds information to or removes information from the desktop database, use the PBDTFlush function to save your changes. The PBDTFlush function writes the contents of the desktop database specified in ioDTRefNum to the volume.

If your application has manipulated information in the database using the PBDTAddIconAsync, PBDTAddIconSync, PBDTAddAPPLAsync, PBDTAddAPPLSync, PBDTSetCommentAsync, PBDTSetCommentSync, PBDTRemoveAPPLAsync, PBDTRemoveAPPLSync, PBDTRemoveCommentAsync, or PBDTRemoveCommentSync functions, you must call PBDTFlush to update the copy stored on the volume.

SPECIAL CONSIDERATIONS

All of the Desktop Manager functions may move or purge memory blocks in the application heap or for some other reason should not be called from within an interrupt. Your application should not call Desktop Manager functions at interrupt time.

AVAILABILITY

Supported in Carbon. Available in Mac OS 8.1 and later when Carbon 1.0.2 or later is present.